home *** CD-ROM | disk | FTP | other *** search
/ ftp.mactech.com 2010 / ftp.mactech.com.tar / ftp.mactech.com / thinkref / archive / THINKPascalUH2.1.sea / THINKPas Univ Hdr 2.1 / Interfaces / Collections.p < prev    next >
Text File  |  1995-09-12  |  12KB  |  337 lines
  1. { Converted with MPW2TPas Tuesday, September 12, 1995 5:33:12 PM }
  2. {
  3.      File:        Collections.p
  4.  
  5.      Contains:    Collection Manager Interfaces.
  6.  
  7.      Version:    Technology:    Quickdraw GX 1.0
  8.                  Package:    Universal Interfaces 2.1 in “MPW Latest” on ETO #18
  9.  
  10.      Copyright:    © 1984-1995 by Apple Computer, Inc.
  11.                  All rights reserved.
  12.  
  13.      Bugs?:        If you find a problem with this file, use the Apple Bug Reporter
  14.                  stack.  Include the file and version information (from above)
  15.                  in the problem description and send to:
  16.                      Internet:    apple.bugs@applelink.apple.com
  17.                      AppleLink:    APPLE.BUGS
  18.  
  19. }
  20.  
  21.  UNIT Collections;
  22.  INTERFACE
  23.  
  24.  
  25. {$IFC UNDEFINED __COLLECTIONS__}
  26. {$SETC __COLLECTIONS__ := 1}
  27.  
  28.   USES
  29.    ConditionalMacros, Types, MixedMode;
  30.  
  31. { $PUSH}
  32. { $ALIGN MAC68K}
  33. { $LibExport+}
  34.  
  35. CONST
  36.     gestaltCollectionMgrVersion    = 'cltn';
  37.  
  38. { Collection Manager Error Result Codes... }
  39.     collectionItemLockedErr        = -5750;
  40.     collectionItemNotFoundErr    = -5751;
  41.     collectionIndexRangeErr        = -5752;
  42.     collectionVersionErr        = -5753;
  43.  
  44. { Convenience constants for functions which optionally return values... }
  45.     dontWantTag                    = 0;
  46.     dontWantId                    = 0;
  47.     dontWantSize                = 0;
  48.     dontWantAttributes            = 0;
  49.     dontWantIndex                = 0;
  50.     dontWantData                = 0;
  51.  
  52. { attributes bits }
  53.     noCollectionAttributes        = $00000000;                    { no attributes bits set }
  54.     allCollectionAttributes        = $FFFFFFFF;                    { all attributes bits set }
  55.     userCollectionAttributes    = $0000FFFF;                    { user attributes bits }
  56.     defaultCollectionAttributes    = $40000000;                    { default attributes - unlocked, persistent }
  57.  
  58. { 
  59.     Attribute bits 0 through 15 (entire low word) are reserved for use by the application.
  60.     Attribute bits 16 through 31 (entire high word) are reserved for use by the Collection Manager.
  61.     Only bits 31 (collectionLockBit) and 30 (collectionPersistenceBit) currently have meaning.
  62. }
  63.     collectionUser0Bit            = 0;
  64.     collectionUser1Bit            = 1;
  65.     collectionUser2Bit            = 2;
  66.     collectionUser3Bit            = 3;
  67.     collectionUser4Bit            = 4;
  68.     collectionUser5Bit            = 5;
  69.     collectionUser6Bit            = 6;
  70.     collectionUser7Bit            = 7;
  71.     collectionUser8Bit            = 8;
  72.     collectionUser9Bit            = 9;
  73.     collectionUser10Bit            = 10;
  74.     collectionUser11Bit            = 11;
  75.     collectionUser12Bit            = 12;
  76.     collectionUser13Bit            = 13;
  77.     collectionUser14Bit            = 14;
  78.     collectionUser15Bit            = 15;
  79.     collectionReserved0Bit        = 16;
  80.     collectionReserved1Bit        = 17;
  81.     collectionReserved2Bit        = 18;
  82.     collectionReserved3Bit        = 19;
  83.     collectionReserved4Bit        = 20;
  84.     collectionReserved5Bit        = 21;
  85.     collectionReserved6Bit        = 22;
  86.     collectionReserved7Bit        = 23;
  87.     collectionReserved8Bit        = 24;
  88.     collectionReserved9Bit        = 25;
  89.     collectionReserved10Bit        = 26;
  90.     collectionReserved11Bit        = 27;
  91.     collectionReserved12Bit        = 28;
  92.     collectionReserved13Bit        = 29;
  93.     collectionPersistenceBit    = 30;
  94.     collectionLockBit            = 31;
  95.  
  96. { attribute masks }
  97.     collectionUser0Mask            = $1;
  98.     collectionUser1Mask            = $2;
  99.     collectionUser2Mask            = $4;
  100.     collectionUser3Mask            = $8;
  101.     collectionUser4Mask            = $10;
  102.     collectionUser5Mask            = $20;
  103.     collectionUser6Mask            = $40;
  104.     collectionUser7Mask            = $80;
  105.     collectionUser8Mask            = $100;
  106.     collectionUser9Mask            = $200;
  107.     collectionUser10Mask        = $400;
  108.     collectionUser11Mask        = $800;
  109.     collectionUser12Mask        = $1000;
  110.     collectionUser13Mask        = $2000;
  111.     collectionUser14Mask        = $4000;
  112.     collectionUser15Mask        = $8000;
  113.     collectionReserved0Mask        = $10000;
  114.     collectionReserved1Mask        = $20000;
  115.     collectionReserved2Mask        = $40000;
  116.     collectionReserved3Mask        = $80000;
  117.     collectionReserved4Mask        = $100000;
  118.     collectionReserved5Mask        = $200000;
  119.     collectionReserved6Mask        = $400000;
  120.     collectionReserved7Mask        = $800000;
  121.     collectionReserved8Mask        = $1000000;
  122.     collectionReserved9Mask        = $2000000;
  123.     collectionReserved10Mask    = $4000000;
  124.     collectionReserved11Mask    = $8000000;
  125.     collectionReserved12Mask    = $10000000;
  126.     collectionReserved13Mask    = $20000000;
  127.     collectionPersistenceMask    = $40000000;
  128.     collectionLockMask            = $80000000;
  129.  
  130. {*********}
  131. { Types   }
  132. {*********}
  133. { abstract data type for a collection }
  134.     
  135. TYPE
  136.     Collection = Ptr;
  137.  
  138.     CollectionTag = FourCharCode;
  139.  
  140.     CollectionFlattenProcPtr = ProcPtr;  { FUNCTION CollectionFlatten(size: LONGINT; data: UNIV Ptr; refCon: UNIV Ptr): OSErr; }
  141.     CollectionExceptionProcPtr = ProcPtr;  { FUNCTION CollectionException(c: Collection; status: OSErr): OSErr; }
  142.     CollectionFlattenUPP = UniversalProcPtr;
  143.     CollectionExceptionUPP = UniversalProcPtr;
  144.  
  145. CONST
  146.     uppCollectionFlattenProcInfo = $00000FE0; { FUNCTION (4 byte param, 4 byte param, 4 byte param): 2 byte result; }
  147.     uppCollectionExceptionProcInfo = $000002E0; { FUNCTION (4 byte param, 2 byte param): 2 byte result; }
  148.  
  149. FUNCTION NewCollectionFlattenProc(userRoutine: CollectionFlattenProcPtr): CollectionFlattenUPP;
  150.     {$IFC NOT GENERATINGCFM }
  151.     INLINE $2E9F;
  152.     {$ENDC}
  153.  
  154. FUNCTION NewCollectionExceptionProc(userRoutine: CollectionExceptionProcPtr): CollectionExceptionUPP;
  155.     {$IFC NOT GENERATINGCFM }
  156.     INLINE $2E9F;
  157.     {$ENDC}
  158.  
  159. FUNCTION CallCollectionFlattenProc(size: LONGINT; data: UNIV Ptr; refCon: UNIV Ptr; userRoutine: CollectionFlattenUPP): OSErr;
  160.     {$IFC NOT GENERATINGCFM}
  161.     INLINE $205F, $4E90;
  162.     {$ENDC}
  163.  
  164. FUNCTION CallCollectionExceptionProc(c: Collection; status: OSErr; userRoutine: CollectionExceptionUPP): OSErr;
  165.     {$IFC NOT GENERATINGCFM}
  166.     INLINE $205F, $4E90;
  167.     {$ENDC}
  168.  
  169. FUNCTION NewCollection: Collection;
  170.     {$IFC NOT GENERATINGCFM}
  171.     INLINE $7000, $ABF6;
  172.     {$ENDC}
  173. PROCEDURE DisposeCollection(c: Collection);
  174.     {$IFC NOT GENERATINGCFM}
  175.     INLINE $7001, $ABF6;
  176.     {$ENDC}
  177. FUNCTION CloneCollection(c: Collection): Collection;
  178.     {$IFC NOT GENERATINGCFM}
  179.     INLINE $7002, $ABF6;
  180.     {$ENDC}
  181. FUNCTION CountCollectionOwners(c: Collection): LONGINT;
  182.     {$IFC NOT GENERATINGCFM}
  183.     INLINE $7003, $ABF6;
  184.     {$ENDC}
  185. FUNCTION CopyCollection(srcCollection: Collection; dstCollection: Collection): Collection;
  186.     {$IFC NOT GENERATINGCFM}
  187.     INLINE $7004, $ABF6;
  188.     {$ENDC}
  189. FUNCTION GetCollectionDefaultAttributes(c: Collection): LONGINT;
  190.     {$IFC NOT GENERATINGCFM}
  191.     INLINE $7005, $ABF6;
  192.     {$ENDC}
  193. PROCEDURE SetCollectionDefaultAttributes(c: Collection; whichAttributes: LONGINT; newAttributes: LONGINT);
  194.     {$IFC NOT GENERATINGCFM}
  195.     INLINE $7006, $ABF6;
  196.     {$ENDC}
  197. FUNCTION CountCollectionItems(c: Collection): LONGINT;
  198.     {$IFC NOT GENERATINGCFM}
  199.     INLINE $7007, $ABF6;
  200.     {$ENDC}
  201. FUNCTION AddCollectionItem(c: Collection; tag: CollectionTag; id: LONGINT; itemSize: LONGINT; itemData: UNIV Ptr): OSErr;
  202.     {$IFC NOT GENERATINGCFM}
  203.     INLINE $7008, $ABF6;
  204.     {$ENDC}
  205. FUNCTION GetCollectionItem(c: Collection; tag: CollectionTag; id: LONGINT; VAR itemSize: LONGINT; itemData: UNIV Ptr): OSErr;
  206.     {$IFC NOT GENERATINGCFM}
  207.     INLINE $7009, $ABF6;
  208.     {$ENDC}
  209. FUNCTION RemoveCollectionItem(c: Collection; tag: CollectionTag; id: LONGINT): OSErr;
  210.     {$IFC NOT GENERATINGCFM}
  211.     INLINE $700A, $ABF6;
  212.     {$ENDC}
  213. FUNCTION SetCollectionItemInfo(c: Collection; tag: CollectionTag; id: LONGINT; whichAttributes: LONGINT; newAttributes: LONGINT): OSErr;
  214.     {$IFC NOT GENERATINGCFM}
  215.     INLINE $700B, $ABF6;
  216.     {$ENDC}
  217. FUNCTION GetCollectionItemInfo(c: Collection; tag: CollectionTag; id: LONGINT; VAR index: LONGINT; VAR itemSize: LONGINT; VAR attributes: LONGINT): OSErr;
  218.     {$IFC NOT GENERATINGCFM}
  219.     INLINE $700C, $ABF6;
  220.     {$ENDC}
  221. FUNCTION ReplaceIndexedCollectionItem(c: Collection; index: LONGINT; itemSize: LONGINT; itemData: UNIV Ptr): OSErr;
  222.     {$IFC NOT GENERATINGCFM}
  223.     INLINE $700D, $ABF6;
  224.     {$ENDC}
  225. FUNCTION GetIndexedCollectionItem(c: Collection; index: LONGINT; VAR itemSize: LONGINT; itemData: UNIV Ptr): OSErr;
  226.     {$IFC NOT GENERATINGCFM}
  227.     INLINE $700E, $ABF6;
  228.     {$ENDC}
  229. FUNCTION RemoveIndexedCollectionItem(c: Collection; index: LONGINT): OSErr;
  230.     {$IFC NOT GENERATINGCFM}
  231.     INLINE $700F, $ABF6;
  232.     {$ENDC}
  233. FUNCTION SetIndexedCollectionItemInfo(c: Collection; index: LONGINT; whichAttributes: LONGINT; newAttributes: LONGINT): OSErr;
  234.     {$IFC NOT GENERATINGCFM}
  235.     INLINE $7010, $ABF6;
  236.     {$ENDC}
  237. FUNCTION GetIndexedCollectionItemInfo(c: Collection; index: LONGINT; VAR tag: CollectionTag; VAR id: LONGINT; VAR itemSize: LONGINT; VAR attributes: LONGINT): OSErr;
  238.     {$IFC NOT GENERATINGCFM}
  239.     INLINE $7011, $ABF6;
  240.     {$ENDC}
  241. FUNCTION CollectionTagExists(c: Collection; tag: CollectionTag): BOOLEAN;
  242.     {$IFC NOT GENERATINGCFM}
  243.     INLINE $7012, $ABF6;
  244.     {$ENDC}
  245. FUNCTION CountCollectionTags(c: Collection): LONGINT;
  246.     {$IFC NOT GENERATINGCFM}
  247.     INLINE $7013, $ABF6;
  248.     {$ENDC}
  249. FUNCTION GetIndexedCollectionTag(c: Collection; tagIndex: LONGINT; VAR tag: CollectionTag): OSErr;
  250.     {$IFC NOT GENERATINGCFM}
  251.     INLINE $7014, $ABF6;
  252.     {$ENDC}
  253. FUNCTION CountTaggedCollectionItems(c: Collection; tag: CollectionTag): LONGINT;
  254.     {$IFC NOT GENERATINGCFM}
  255.     INLINE $7015, $ABF6;
  256.     {$ENDC}
  257. FUNCTION GetTaggedCollectionItem(c: Collection; tag: CollectionTag; whichItem: LONGINT; VAR itemSize: LONGINT; itemData: UNIV Ptr): OSErr;
  258.     {$IFC NOT GENERATINGCFM}
  259.     INLINE $7016, $ABF6;
  260.     {$ENDC}
  261. FUNCTION GetTaggedCollectionItemInfo(c: Collection; tag: CollectionTag; whichItem: LONGINT; VAR id: LONGINT; VAR index: LONGINT; VAR itemSize: LONGINT; VAR attributes: LONGINT): OSErr;
  262.     {$IFC NOT GENERATINGCFM}
  263.     INLINE $7017, $ABF6;
  264.     {$ENDC}
  265. PROCEDURE PurgeCollection(c: Collection; whichAttributes: LONGINT; matchingAttributes: LONGINT);
  266.     {$IFC NOT GENERATINGCFM}
  267.     INLINE $7018, $ABF6;
  268.     {$ENDC}
  269. PROCEDURE PurgeCollectionTag(c: Collection; tag: CollectionTag);
  270.     {$IFC NOT GENERATINGCFM}
  271.     INLINE $7019, $ABF6;
  272.     {$ENDC}
  273. PROCEDURE EmptyCollection(c: Collection);
  274.     {$IFC NOT GENERATINGCFM}
  275.     INLINE $701A, $ABF6;
  276.     {$ENDC}
  277. FUNCTION FlattenCollection(c: Collection; flattenProc: CollectionFlattenUPP; refCon: UNIV Ptr): OSErr;
  278.     {$IFC NOT GENERATINGCFM}
  279.     INLINE $701B, $ABF6;
  280.     {$ENDC}
  281. FUNCTION FlattenPartialCollection(c: Collection; flattenProc: CollectionFlattenUPP; refCon: UNIV Ptr; whichAttributes: LONGINT; matchingAttributes: LONGINT): OSErr;
  282.     {$IFC NOT GENERATINGCFM}
  283.     INLINE $701C, $ABF6;
  284.     {$ENDC}
  285. FUNCTION UnflattenCollection(c: Collection; flattenProc: CollectionFlattenUPP; refCon: UNIV Ptr): OSErr;
  286.     {$IFC NOT GENERATINGCFM}
  287.     INLINE $701D, $ABF6;
  288.     {$ENDC}
  289. FUNCTION GetCollectionExceptionProc(c: Collection): CollectionExceptionUPP;
  290.     {$IFC NOT GENERATINGCFM}
  291.     INLINE $701E, $ABF6;
  292.     {$ENDC}
  293. PROCEDURE SetCollectionExceptionProc(c: Collection; exceptionProc: CollectionExceptionUPP);
  294.     {$IFC NOT GENERATINGCFM}
  295.     INLINE $701F, $ABF6;
  296.     {$ENDC}
  297. {***************************************************************************************}
  298. { Utility Routines for handle-based access...                                                          }
  299. {***************************************************************************************}
  300. FUNCTION GetNewCollection(collectionID: INTEGER): Collection;
  301.     {$IFC NOT GENERATINGCFM}
  302.     INLINE $7020, $ABF6;
  303.     {$ENDC}
  304. FUNCTION AddCollectionItemHdl(aCollection: Collection; tag: CollectionTag; id: LONGINT; itemData: Handle): OSErr;
  305.     {$IFC NOT GENERATINGCFM}
  306.     INLINE $7021, $ABF6;
  307.     {$ENDC}
  308. FUNCTION GetCollectionItemHdl(aCollection: Collection; tag: CollectionTag; id: LONGINT; itemData: Handle): OSErr;
  309.     {$IFC NOT GENERATINGCFM}
  310.     INLINE $7022, $ABF6;
  311.     {$ENDC}
  312. FUNCTION ReplaceIndexedCollectionItemHdl(aCollection: Collection; index: LONGINT; itemData: Handle): OSErr;
  313.     {$IFC NOT GENERATINGCFM}
  314.     INLINE $7023, $ABF6;
  315.     {$ENDC}
  316. FUNCTION GetIndexedCollectionItemHdl(aCollection: Collection; index: LONGINT; itemData: Handle): OSErr;
  317.     {$IFC NOT GENERATINGCFM}
  318.     INLINE $7024, $ABF6;
  319.     {$ENDC}
  320. FUNCTION FlattenCollectionToHdl(aCollection: Collection; flattened: Handle): OSErr;
  321.     {$IFC NOT GENERATINGCFM}
  322.     INLINE $7025, $ABF6;
  323.     {$ENDC}
  324. FUNCTION UnflattenCollectionFromHdl(aCollection: Collection; flattened: Handle): OSErr;
  325.     {$IFC NOT GENERATINGCFM}
  326.     INLINE $7026, $ABF6;
  327.     {$ENDC}
  328.  
  329. { $ALIGN RESET}
  330. { $POP}
  331.  
  332. {$ENDC} {__COLLECTIONS__}
  333.  
  334.  IMPLEMENTATION
  335.  END.
  336.  
  337.